DataBoundControl
The DataBoundControl class provides a base for visual controls that bind to entity data and support validation, data loading, and state comparison.
Properties
| Name | Description |
|---|---|
| ContextMenuColumnKey | The key of the column associated with the context menu. |
| Caption | The caption of the control. |
| Loading | Indicates whether the control is in a loading state. |
| ControlId | The unique identifier of the control. |
| Style | The styling properties for the control. |
| ClientEvents | A list of client-side events associated with the control. |
| ReadOnly | Gets or sets whether the control is read-only. |
| ContextMenuTarget | The target of the context menu. |
| Required | Gets or sets whether the control requires a value for validation. |
| DefaultReadOnly | Gets or sets the default read-only state of the control. |
| Title | The title of the control. |
| ExecutedServerEvents | A list of server events that have been executed. |
| EntityPath | Gets or sets the data path used for binding this control to an entity. |
| Name | The name of the control. |
| Visible | Indicates whether the control is visible. |
| ClientVisible | Indicates whether the control is visible on the client side. |
| Indexable | Gets or sets whether the control's data is indexable for search and querying. |
| ServerEvents | A list of server-side events associated with the control. |
| DefaultClientEnabled | Indicates whether the control is enabled by default on the client side. |
| ClientReadOnly | Gets or sets whether the control is read-only on the client side, regardless of server state. |
| ClientEnabled | Indicates whether the control is enabled on the client side. |
| Enabled | Indicates whether the control is enabled. |
| ContextMenuKey | The key associated with the context menu. |
| ContainerStyle | The styling properties for the container of the control. |
| CustomClassName | The custom CSS class name applied to the control. |
| Size | Gets or sets the layout size configuration for the control. |
| DefaultEnabled | Indicates whether the control is enabled by default. |
Constructors
| Name | Description |
|---|---|
| BaseControl() | Initializes a new instance of the DataBoundControl class with default values. |
| DataBoundControl() | Initializes a new instance of the DataBoundControl class with empty event lists. |
Methods
| Name | Description |
|---|---|
| ScrollTo() | Scrolls to the control. |
| HideLoading() | Removes the loading state from the control. |
| FireClick() | Triggers the Click event. |
| OnInit(sender, e) | Raises the Init event. |
| Hide() | Hides the control. |
| OnPropertyValueGet(sender, e) | Raises the PropertyValueGet event. |
| Show() | Makes the control visible. |
| Equals(other) | Determines whether the specified DataBoundControl is equal to the current control. |
| OnDataLoad(sender, e) | Raises the DataLoad event with the provided arguments. |
| OnRender(sender, e) | Raises the Render event. |
| OnLoad(sender, e) | Raises the Load event. |
| GetProtectedData(isDisabledOrReadOnly) | #import (Bimser.CSP.FormControls.Base.ICanProtectData.GetProtectedData(bool)) (shortDescription) |
| ToggleLoading() | Toggles the loading state of the control. |
| GetDifferences(otherObj) | Compares the current instance with another control and returns the differences. |
| SetPropertyValue(mapping, value) | Sets the value of a property specified by a mapping. |
| ClearDefaultValue() | Clears the control’s default value. Can be overridden in derived classes. |
| OnPropertyChanged(sender, e) | Handles the property changed event. |
| GetValueAsObject() | Gets the current value of the control as a generic object. Override to return meaningful data in derived types. |
| ShowLoading() | Sets the control to a loading state. |
| OnPreRender(sender, e) | Raises the PreRender event. |
| GetDifferences(otherObj) | Compares the current control with another and returns a dictionary of differences. |
| Equals(obj) | Determines whether the specified object is equal to the current control. |
| OnValidating(sender, e) | Raises the Validating event with the provided arguments. |
| OnPropertyChanging(sender, e) | Handles the property changing event. |
| OnDoubleClick(sender, e) | Raises the DoubleClick event. |
| GetData() | Gets the control’s current data, including type, text, and value, as a structured object. |
| IsValid() | Returns a value indicating whether the control’s current value is valid. |
| OnClick(sender, e) | Raises the Click event. |
| GetHashCode() | Returns a hash code for the current control instance. |
Events
| Name | Description |
|---|---|
| Validating | Raised before the control's value is validated. |
| Init | Triggered when the control is initialized. |
| Load | Triggered when the control is loaded. |
| DoubleClick | Triggered when the control is double-clicked. |
| LazyLoading | Raised when the control initiates a lazy-loading operation to fetch additional data. |
| PreRender | Triggered before the control is rendered. |
| PropertyValueGet | Triggered when retrieving a control property value. |
| Click | Triggered when the control is clicked. |
| DataLoad | Raised when external data is loaded into the control. |
| Render | Triggered when the control is rendered. |